Skip to content

Add MkDocs Material documentation site#10

Merged
DanialBeg merged 2 commits intomainfrom
docs/mkdocs-material
Mar 17, 2026
Merged

Add MkDocs Material documentation site#10
DanialBeg merged 2 commits intomainfrom
docs/mkdocs-material

Conversation

@DanialBeg
Copy link
Contributor

@DanialBeg DanialBeg commented Mar 17, 2026

Summary

  • 18 documentation pages covering all features, configuration, and deployment
  • MkDocs Material with dark theme matching the AgentLedger dashboard aesthetic
  • GitHub Actions workflow for auto-deploy to GitHub Pages on push to main
  • Makefile targets: make docs, make docs-serve

Pages

  • Home — landing page with architecture, feature highlights, LiteLLM comparison
  • Getting Started — installation, quick start, CLI reference
  • Configuration — overview + full annotated reference
  • Features — providers, budgets, agent tracking, MCP, dashboard, multi-tenancy, alerting, rate limiting, circuit breaker, observability
  • Admin API — endpoints, auth, curl examples
  • Deployment — Docker, Kubernetes/Helm
  • Roadmap — completed phases + future

Setup Required

After merge, go to repo Settings > Pages > Source and set to GitHub Actions to enable auto-deploy to wdz-dev.github.io/agent-ledger.

Test plan

  • mkdocs build --strict passes with zero warnings
  • make docs-serve verified locally at localhost:8000
  • After merge, verify GitHub Pages deployment

- 18 documentation pages covering all features, configuration, and deployment
- MkDocs Material with dark theme matching dashboard aesthetic
- GitHub Actions workflow for auto-deploy to GitHub Pages
- Makefile targets: docs, docs-serve
- Content sourced from README, WEBSITE_BRIEF, and example config
- Tabbed code blocks, admonitions, code copy buttons, search
@DanialBeg DanialBeg self-assigned this Mar 17, 2026
@DanialBeg DanialBeg merged commit 2f191b3 into main Mar 17, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant